home *** CD-ROM | disk | FTP | other *** search
/ Shareware Avalanche! / Shareware Avalanche!.iso / brainex / rombrain.doc < prev    next >
Text File  |  1993-01-07  |  13KB  |  333 lines
  1. Jan 8, 1992
  2.  
  3.                                   ROMBRAIN 2
  4.                      (C) Copyright 1992 by Stanley Sheff
  5.                        Support BBS: The Brainex System
  6.                                (310) 275-2344
  7.                                (310) 273-5234
  8.  
  9.                                ---------------
  10.  
  11.    Welcome to the RomBrain. Now your callers can access your CDROM drive
  12.    without having to use your BBS's file system.  This door works with
  13.    GAP, PCBoard, Wildcat, Spitfire, WWIV, and RBBS, as well as any BBS that
  14.    generates a DOOR.SYS file when running a door.  RomBrain is a multi-user
  15.    door and requires SHARE.EXE and DOS 3.3 or above.  RomBrain writes user's
  16.    download stats to DOOR.SYS for BBSes that read this back in to update
  17.    user information.  
  18.    
  19.    PCBoard Note
  20.    ============
  21.    Do not SHELL to use this door. Write USERS.SYS and DOOR.SYS
  22.    when running this door!
  23.    
  24.    * RomBrain requires: 
  25.    DSZ.COM or DSZ.EXE in the path. If you have an unregistered DSZ, 
  26.    Y-Modem G protocol will NOT function.  If you wish to use GSZ,
  27.    simply rename GSZ.EXE to DSZ.EXE, or you can edit the batch files
  28.    that call GSZ. They are located in the BRAINEX directory, and
  29.    are named: EXTSZ.BAT, EXTS1.BAT, etc.  You should add an environment
  30.    variable to set the dsz log file name, and if using gsz, the window
  31.    size. If the DSZLOG varible is not set, NO download logs will be
  32.    written.  See the sample Rombrain batch files below.
  33.    
  34.    
  35.    
  36.    The Brainex Door Manager. If you have not done so, please obtain the 
  37.    file BRAINEX.ZIP, available from the Brainex System. Install the Door
  38.    Manager before you install Rombrain.
  39.  
  40.    Here's what the RomBrain can do:
  41.  
  42.    Supports IBM ANSI Color and plain text mode (ASCII) 
  43.    for your callers who don't use IBM characters or don't use ANSI.
  44.    
  45.    RomBrain creates an index file from information stored on your CD.
  46.       
  47.    Menu Functions:
  48.  
  49.    [C]hange CDROM Volume
  50.    If you use more than one CDROM disk, users may select another
  51.    disk. RomBrain can detect if the CDROM disk is ONLINE. If it's
  52.    OFFLINE, they can optionally request a file for download from
  53.    the Request door. The sysop may optionally have rombrain write 
  54.    a request notification text file.  This file is indicated by
  55.    when setting up the Rombrain with BRAINSET.EXE. 
  56.    
  57.    [O]ffline requests
  58.    If you have installed the Request option, users can download
  59.    requested offline files.
  60.    
  61.    [X] Color Toggle
  62.    Switch between IBM ANSI Color and plain text mode (ASCII). 
  63.    
  64.    [F]ile Directory
  65.    Allows you to select one of the CDROM directories.  Once you've 
  66.    selected a directory, you may:
  67.  
  68.    [D]ownload file(s)
  69.    You can add names to a list of files for download.  The list
  70.    may be edited.  If you use Xmodem Protocol, each file will
  71.    be sent one at a time, and you will be asked if you wish to
  72.    continue receiving files from the list.
  73.  
  74.    [M]ark a file 
  75.    Add the file name entered to a list to be downloaded later.
  76.    Just type the letter shown to the left of the filename. 
  77.  
  78.                                                                      2.
  79.  
  80.    [A]rchive
  81.    View contents of a .ZIP file, Read a file from within the .ZIP file,
  82.    Transfer (Download) a file from within the .ZIP file, or Download 
  83.    the entire .ZIP file.
  84.  
  85.    [S]earch for text within the directory.  You may enter all or any
  86.    part of a word for a search.  This function searches filename, date,
  87.    and description. Selected word will be highlighted in red for color
  88.    or <brackets> for monochrome.
  89.  
  90.    The above commands are available from the Main Menu as well as the
  91.    Directory Menu.
  92.  
  93.   *NOTE: When asked to enter a file name, .ZIP will be added automatically
  94.          if you do not include an extender.  
  95.  
  96.  
  97.     RomBrain Files
  98.     ----------------
  99.     ROMBRAIN.EXE <------------------ RomBrain Program
  100.     ROMBRAIN.DOC <------------------ Sysop's Information
  101.     REGISTER.DOC <------------------ Registration information
  102.     COMPILE.DOC  <------------------ Filebase Creator information
  103.     COMPILE.EXE  <------------------ Filebase Creator - Auto Create
  104.     CUSTOM.EXE   <------------------ Filebase Creator - Do it yourself!
  105.     ROMBRAIN.HLP <------------------ General Help File
  106.     CDHELP.HLP   <------------------ Download Help File
  107.     WELCOME      <------------------ ASCII Welcome Screen     
  108.     WELCOMEG     <------------------ ANSI Welcome Screen
  109.  
  110.     Also included are files for the optional offline request door.
  111.      
  112.     REQUEST.EXE <------------------ Request Program
  113.     REQUEST.DOC <------------------ Sysop's Information
  114.     NOTICE.EXE  <------------------ Offline Request Notice File Display Prg.
  115.     NOTICE.DOC  <------------------ Instructions for NOTICE.EXE
  116.  
  117.    All of these files should be in this ZIP, if they are not, don't
  118.    take a chance! Call The Brainex System and get a good copy or view the 
  119.    file on a few local boards to see if you can find a complete copy.
  120.  
  121.    RomBrain handles all of its file transfers by shelling to DSZ.EXE or
  122.    DSZ.COM. It is best to use the registered version to enable Y-Modem G.
  123.    Parameters are passed to the protocol batch files in the following order:
  124.    
  125.         %1 - Communications port
  126.         %2 - Baud rate
  127.         %3 - File name to send
  128.         %4 - Node Number (useful for multinode batch files)
  129.                                                                      
  130.    SETUP
  131.    =====
  132.    This door requires the Brainex Door Manager, available from the
  133.    Brainex BBS. Once you have configured the door manager, just
  134.    select the door installation section and answer the questionairre.
  135.  
  136.    The setup of RomBrain is simple, all you need to do is create a
  137.    directory called ROMBRAIN for RomBrain and its files, then copy the
  138.    files into that directory.
  139.  
  140.    
  141.    1. Be sure you have the CD you are going to use inserted into your
  142.       CDROM drive.
  143.  
  144.    2. From the BRAINEX directory, type BRAINSET.
  145.  
  146.    3. Fill in all the required information.
  147.  
  148.    4. Use the COMPILE program if you need to create a filebase for your disk.
  149.  
  150.    * NOTE * COMPILE supports these CDs: Night Owl, So Much Shareware,
  151.             RBBS in a Box, Shareware Grab Bag, So Much Stareware.  
  152.             Ready made file bases are available for download from 
  153.             Brainex BBS.
  154.  
  155.    5. The Compiler will automatically read required information from
  156.       your CD and create a filebase in the directory indicated by the
  157.       BRAINSET program.
  158.  
  159.    When COMPILE is complete...
  160.  
  161.    If you like, you may edit the file CDTYPE_x.4 to customize category names.
  162.    The "x" will be substituted for CD type. Ex. CDTYPE_A.4 is for type A,
  163.    CARRS Night Owl CD.
  164.  
  165.    The COMPILE program will create the following files:
  166.  
  167.    CDTYPE_x.1
  168.    CDTYPE_x.2
  169.    CDTYPE_x.3
  170.    CDTYPE_x.4  (ASCII file of category names.  Edit this for accuracy!)
  171.  
  172.                               -------------------
  173.  
  174.    The file directory menu is generated internally by the RomBrain,
  175.    but if you wish to use a customized menu, just create your own menu
  176.    and name it MENUx for ASCII and MENUxG for ANSI.  "x" stands for
  177.    the CD Type (MENUA=CARRS, etc.). Place the MENUx files in
  178.    the same directory as RomBrain.
  179.  
  180.                                                                      4.
  181.    ---------------------------------------------------------------------
  182.    MULTIPLE CD FILEBASE OPTION
  183.    ===========================
  184.    If you use more than one CD drive, you can use the COMPILE to create
  185.    a set of data files for each.  Example:
  186.  
  187.    CARRS CD would have these files:
  188.  
  189.    CDTYPE_A.1    CDTYPE_A.2    CDTYPE_A.3   CDTYPE_A.4
  190.  
  191.    RBBS IN A BOX would have these:
  192.  
  193.    CDTYPE_C.1    CDTYPE_C.2    CDTYPE_C.3   CDTYPE_C.4 
  194.  
  195.    COMPILE will create a directory for each set of cdtype files, then copy
  196.    the files into the directory you specify.
  197.  
  198.    ------------------------------------------------------------------------
  199.  
  200.    Once you have created your filebase, you must then create
  201.    a batch file to run the door. A batch file for a GAP BBS looks like this:
  202.    
  203.      @ECHO OFF
  204.      SET DSZLOG=LOG1
  205.      SET GSZWINDOW=23
  206.      ROMBRAIN
  207.  
  208.  
  209.    You will also need to modify your doors menu files and the data
  210.    file that tells the BBS what your doors are and the security
  211.    level needed to access them. For GAP, these are respectively:
  212.    
  213.        DOORM
  214.        DOORMG
  215.        DOORS.DAT
  216.  
  217.    Please refer to your BBS documentation for details on 
  218.    setting up these files.
  219.  
  220.  
  221.    For multinode operation, add the node number to the command line:
  222.  
  223.    ROMBRAIN NODE=1
  224.    or
  225.    ROMBRAIN NODE=2
  226.    etc.
  227.  
  228.    You may indicate a different INI file by using the INI= on the
  229.    command line. Example:
  230.  
  231.    ROMBRAIN INI=C:\BRAINEX\ADULT.INI
  232.    This could contain a completely different setup for cd-roms and
  233.    user levels.
  234.  
  235.  
  236.  
  237.  
  238.    STARTUP/MENU SCREENS    
  239.    ====================
  240.    If you wish to bypass the welcome screen, rename or delete the
  241.    WELCOME and WELCOMEG files.  If you would like to use a different
  242.    menu screen, create your screen(s) and name them START for ASCII TEXT
  243.    and STARTG for ANSI menu screen.
  244.  
  245.  
  246.    FILE RATIOS
  247.    ===========
  248.    If you wish to enforce an upload/download ratio, you will need to
  249.    create a RATIO file using any ASCII word processor. The format of
  250.    the RATIO file is:
  251.  
  252.    LEVEL=x  RATIO=y
  253.  
  254.    Where x=user level and y=number of downloads for each upload.
  255.    Place each level/ratio on a separate line.
  256.  
  257.    Example:
  258.  
  259.    LEVEL=50 RATIO=15
  260.    LEVEL=90 RATIO=5
  261.    LEVEL=100 RATIO=1
  262.  
  263.    Only included levels will be affected by the download ratio.
  264.    When you have created the RATIO file, place it in the BRAINEX directory,
  265.    which should also be the location of ROMBRAIN.EXE.
  266.  
  267.    BYPASS DOWNLOAD LIMITS (Registered Version)
  268.    ===========================================
  269.    Add NOLIMIT to the command line to bypass all download limits.
  270.    This is useful for BBS types that do not write DOOR.SYS correctly.
  271.    Rombrain reads the amount of bytes/files available to each user from
  272.    DOOR.SYS written by the BBS.
  273.  
  274.    Example:
  275.  
  276.    ROMBRAIN NOLIMIT NODE=1
  277.  
  278.  
  279.    The following sysop functions are available while awaiting
  280.    keyboard input :
  281.  
  282.      F5      - Shell to DOS.
  283.      F8      - Twit user and return to BBS.
  284.     F10      - Initiate chat with user. ESC to EXIT chat.
  285.     CF10     - Answer user page bell.
  286.     Home     - Main user stats.
  287.     End      - Displays sysop keys available.
  288.     PgDn     - Secondary user stats.
  289.     Up Arrow - Increase user's time remaining by 5 minutes.
  290.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  291.  
  292.    One of the nicer features about using the TWIT key, is the user
  293.    is not told that "the sysop wants them to return to the BBS".
  294.    Instead, a very plain and simple message of "returning you to the
  295.    BBS" is displayed.  This way, the user is given no indication
  296.    that the sysop is hovering about. When using the F5 shell to DOS
  297.    key, to return to the door program, simply type EXIT at the DOS command
  298.    prompt. It is not necessary to change directories back to the door
  299.    directory. RomBrain is smart enough to know which drive and directory
  300.    the door program is in and will reset the defaults upon return from DOS.
  301.  
  302.    The Up and Down Arrow keys increase and decrease the user's time
  303.    respectively by 5 minutes for each press of the key. There is no
  304.    indication of what is occurring (except by the fact the user's
  305.    time remaining will change), so the sysop should try not to have
  306.    a lead finger. The increase or decrease is effective only while
  307.    the user is in RomBrain.
  308.  
  309.    This version of RomBrain is a DEMO. File Transfers are limited to
  310.    300,000 bytes and 2 files per session. It will become full featured 
  311.    upon registration. This door is released "As Is" and there is *NO* 
  312.    warranty or guarantee that it will work for you and not cause any 
  313.    problems. You have chosen to use this door, YOU are responsible for 
  314.    any unfortunate problems that may develop from its use or misuse. 
  315.    I will gladly listen to any suggestions or problems you may have, 
  316.    and I will do my best to fix whatever needs to be fixed. I can not be 
  317.    held responsible for any problems you may have, whether directly or 
  318.    indirectly due to the use of the door or its utilities or associated 
  319.    files. Please be sure the program works for you before you register!
  320.    
  321.    Please read REGISTER.DOC for information on how you can register
  322.    your copy of RomBrain. The download option will only work on
  323.    a registered version.
  324.  
  325.    For complete support, contact Stanley Sheff on The Brainex System.
  326.    Your questions will be quickly and cheerfully answered!
  327.  
  328.    Stanley Sheff
  329.    The Brainex System
  330.    310-275-2344 HST
  331.    310-273-5234 MNP
  332.  
  333.